/**
 * DatabaseInfo.java
 *
 * Copyright (C) 2003 MaxMind LLC.  All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.peerfact.impl.network.gnp.geoip;

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * Encapsulates metadata about the GeoIP database. The database has a date, is a
 * premium or standard version, and is one of the following types:
 * 
 * <ul>
 * <li>Country edition -- this is the most common version of the database. It
 * includes the name of the country and it's ISO country code given an IP
 * address.
 * <li>Region edition -- includes the country information as well as what U.S.
 * state or Canadian province the IP address is from if the IP address is from
 * the U.S. or Canada.
 * <li>City edition -- includes country, region, city, postal code, latitude,
 * and longitude information.
 * <li>Org edition -- includes country and netblock owner.
 * <li>ISP edition -- includes country, region, city, postal code, latitude,
 * longitude, ISP, and organization information.
 * </ul>
 * 
 * @see com.maxmind.geoip.LookupService#getDatabaseInfo()
 * @author Matt Tucker
 */
public class DatabaseInfo {

	public final static int COUNTRY_EDITION = 1;

	public final static int REGION_EDITION_REV0 = 7;

	public final static int REGION_EDITION_REV1 = 3;

	public final static int CITY_EDITION_REV0 = 6;

	public final static int CITY_EDITION_REV1 = 2;

	public final static int ORG_EDITION = 5;

	public final static int ISP_EDITION = 4;

	public final static int PROXY_EDITION = 8;

	public final static int ASNUM_EDITION = 9;

	public final static int NETSPEED_EDITION = 10;

	private static SimpleDateFormat formatter = new SimpleDateFormat("yyyyMMdd");

	private String info;

	/**
	 * Creates a new DatabaseInfo object given the database info String.
	 * 
	 * @param info
	 */
	public DatabaseInfo(String info) {
		this.info = info;
	}

	public int getType() {
		if (info == null || info.equals("")) {
			return COUNTRY_EDITION;
		} else {
			// Get the type code from the database info string and then
			// subtract 105 from the value to preserve compatability with
			// databases from April 2003 and earlier.
			return Integer.parseInt(info.substring(4, 7)) - 105;
		}
	}

	/**
	 * Returns true if the database is the premium version.
	 * 
	 * @return true if the premium version of the database.
	 */
	public boolean isPremium() {
		return info.indexOf("FREE") < 0;
	}

	/**
	 * Returns the date of the database.
	 * 
	 * @return the date of the database.
	 */
	public Date getDate() {
		for (int i = 0; i < info.length() - 9; i++) {
			if (Character.isWhitespace(info.charAt(i))) {
				String dateString = info.substring(i + 1, i + 9);
				try {
					synchronized (formatter) {
						return formatter.parse(dateString);
					}
				} catch (ParseException pe) {
					// No implementation here (not sure why) by Thim
					// This text is here so that later on someone will find
					// this.
				}
				break;
			}
		}
		return null;
	}

	@Override
	public String toString() {
		return info;
	}
}
